[beta] Get Function logs.

Retrieve paginated log entries for a specific Function within a given time range. Logs are produced during Function executions and can be filtered by text content.

Rate limit: 100 requests/min (learn more about rate limits here).

To use this endpoint, select Read Functions under the Functions category when creating or editing an API token. Learn More.

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

GET /functions/{name}/logs

[beta] Get Function logs.

cURL

curl --request GET \
  --url https://api.samsara.com/functions/{name}/logs \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "log": "Processing batch of 50 records...",
      "loggedAtTime": "2024-01-01T12:00:00Z"
    }
  ],
  "pagination": {
    "endCursor": "MjkY",
    "hasNextPage": true
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

name · string · required

The name of the Function whose logs to retrieve.

Query Parameters

startTime · string<date-time> · required

Required RFC 3339 timestamp for the beginning of the log time range.

endTime · string<date-time> · required

Required RFC 3339 timestamp for the end of the log time range.

after · string

If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.

limit · integer · default: 100

The maximum number of log entries to return per page. Default is 100.

Required range: 1 <= x <= 512

filterText · string

Optional text to filter log entries. Only logs containing this text will be returned.

Response

200

application/json

OK response.

data · object[] · required

Array of log entries.

Show child attributes

pagination · object · required

Pagination parameters.

Show child attributes